TVD Connector Data Fields (SWMM)
TVD Connector data can be edited on either the TVD Connector Grid Window of the Polygons Grid or the TVD Connector Property Sheet.
The following describes all the data which can be used to define a TVD Connector.
Fields that are common to the majority of objects can be found in the Common Fields topic.
TVD Connector Data
Database Table Name: sw_tvd_connector
Field Name |
Help Text |
Database Field |
Size |
Precision |
Default |
Error Lower Limit |
Error Upper Limit |
Warning Lower Limit |
Warning Upper Limit |
|||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ID |
Unique identifier for the TVD connector. If the TVD connector is to be used to control a regulatory object such as a pump, the ID should be the same as the time series in the relevant the SWMM Control Rule. |
id | Text | 64 | 0 | |||||||||||||||
Category |
Optional user-defined category. |
category_id | Text | 64 | 0 | |||||||||||||||
X coord | X coordinate of the object. | x | Double | XY | 2 | |||||||||||||||
Y coord | Y coordinate of the object. | y | Double | XY | 2 | |||||||||||||||
Area | Area covered by the TVD connector. Default area is calculated from polygon geometry if the TVD connector is a polygon, or set to null if TVD connector is a point. | area | Double | CA | 3 | |||||||||||||||
Input A units type | The data measurement type for Input A. | input_a_units | Text | 8 | 0 | |||||||||||||||
Input A |
This may be one of the following:
If a number is specified, InfoWorks ICM first checks if it matches any existing TVD connectors IDs. If it does, then InfoWorks ICM uses that TVD connector as the input. If not, the software treats the number as a constant with units determined by the Connector units field. |
input_a | Text | 64 | 0 | |||||||||||||||
Input B units type | The data measurement type for Input B. | input_b_units | Text | 8 | 0 | |||||||||||||||
Input B |
See Input A. By default, inputs are used as a sequential data sources. For example, if a data stream is specified in Input A and it has missing values, the Input B data stream will be used to fill the gaps. However, this field may also be simultaneously, for example, in an SQL expression. |
input_b | Text | 64 | 0 | |||||||||||||||
Input C units type | The data measurement type for Input C. | input_c_units | Text | 8 | 0 | |||||||||||||||
Input C |
See Input A. By default, inputs are used as a sequential data sources. For example, if a data stream is specified in Input A and Input B fields and both have missing values at the same timesteps, the Input C data stream will be used to fill the gaps. However, this field may also be simultaneously, for example, in an SQL expression. |
input_c | Text | 64 | 0 | |||||||||||||||
Output units type |
The data measurement type for output from the TVD connector. Note
Evaporation and temperature can be specified either as outputs of a TVD connector or as inputs to rainfall TVD connectors, but not both. If they do, the model will fail validation unless the Output units type field is left blank. |
output_units | Text | 8 | 0 | |||||||||||||||
Connector units |
Determines how any values calculated internally (by an explicitly-entered output expression or using inputs that are specified as numerical constants) should be converted into native units of the specified output type. The options available in the dropdown list are populated when an Output units type is selected. |
output_units | Text | 8 | 0 | |||||||||||||||
Output expression |
The SQL expression used with this TVD connector. An expression can be specified using the SQL Expression dialog which is displayed by clicking on the button. Note
The SQL functions and operators which can be used in the expression are listed in the TVD Connector - SQL Expression Dialog topic. An expression can also be tested from the dialog. |
output_expression | Memo | |||||||||||||||||
Resampling buffer |
The resampling buffer is the length (in minutes) of the additional period of input data prior to the run start time which must be captured in order to ensure that resampled values at and shortly after the run start time are correct. It should be non-zero only if the TVD connector has an expression that uses the TSRESAMPLE function. |
|||||||||||||||||||
Connected object type |
Type of network object that the TVD connector is connected to. |
connected_object_type | Text | 32 | 0 | |||||||||||||||
Connected object id |
Enabled when Connected object type is set. The ID of the network object that the TVD connector is connected to. |
connected_object_id | Text | 66 | 0 | |||||||||||||||
Connection usage |
Enabled when Connected object id is set.
|
usage | Text | 16 | 0 | |||||||||||||||
Input attribute |
Enabled when Connection usage is set to Input and a Connected object id is set. The data type of the data to be input to the connected network object. |
input_attribute | Text | 16 | 0 | |||||||||||||||
Comparison result |
Enabled when Connection usage is set to Comparison and a Connected object id is set. The data type of the result data to be made available for comparison with the results of the connected network object. |
comparison_result | Text | 16 | 0 |